Merge pull request #10429 from iNavFlight/mmosca-patch-4
[inav.git] / docs / Serial Gimbal.md
blobc2c35b90af11531fd6f10c344cf062f775324df2
1 # Serial Gimbal
2 INAV 8.0 introduces support for serial Gimbals. Currently, it is compatible with the protocol used by the Walksnail GM series gimbals.
4 While these gimbals also support PWM as input, using the Serial protocol gives it more flexibility and saves up to 4 PWM channels. The downside of the Serial protocol vs PWM input is that you don't have access to the full power of INAV's mixers. The main advantage is that you gain easy control of gimbal functions using INAV's modes.
6 # Axis Input
7 The Serial Gimbal supports 2 differents inputs.
9 ## PWM Channels
10 This is the simplest way to control the Gimbal, as you can use your radio mixer and sliders to Control the gimbal by assigning RC channels to functions in the ```Configuration``` tab. You can control all 3 gimbal axis and unlike the raw PWM input, gimbal modes are controlled by INAV modes and you can control roll channel as well, instead of wiring 4 servo outputs. If an rc channel is set to 0, that input will be ignore and will be equivalent to a centered RC channel. So, if you setup the serial gimbal and don't assign any rc channels, it will stay centered, with default sensitivity and will obey the Gimbal MODES setup in the Modes tab.
12 ## Headtracker Input
13 Headtracker input is only used when you have a Headtracker device configured and the ```Gimbal Headtracker``` mode is active. 
14 A Headtracker device is a device that transmits headtracker information by a side channel, instead of relying on your rc link.
16 In head tracker mode, the Serial Gimbal will ignore the axis rc channel inputs and replace it with the inputs coming from the Headtracker device.
18 # Gimbal Modes
19 ## No Gimbal mode selected
20 Like ACRO is the default mode for flight modes, the Gimbal will default to ```FPV Mode``` or ```Follow Mode``` when no mode is selected. The gimbal will try to stablized the footage and will follow the aircraft pitch, roll and yaw movements and use user inputs to point the camera where the user wants.
22 ## Gimbal Center
23 This locks the gimbal camera to the center position and ignores any user input. Useful to reset the camera if you loose orientation.
25 ## Gimbal Headtracker
26 Switches inputs to the configured Headtracker device. If no device is configured it will behave like Gimbal Center.
28 ## Gimbal Level Tilt
29 This mode locks the camera tilt (pitch axis) and keeps it level with the horizon. Pitching the aircraft up and down, will move the camera so it stays pointing at the horizon. It can be combined with ```Gimbal Level Roll```.
31 ## Gimbal Level Roll
32 This mode locks the camera roll and keeps it level with the horizon. Rolling the aircraft will move the camera so it stays level with the horizon. It can be combined with ```Gimbal Level Tilt```.
34 # Advanced settings
35 The gimbal also supports some advanced settings not exposed in the configurator.
37 ## Gimbal Trim
38 You can set a trim setting for the gimbal, the idea is that it will shift the notion of center of the gimbal, like a trim and let you setup a fixed camera up tilt, like you would have in a traditional fpv quad setup.
40 ```
41 gimbal_pan_trim = 0
42 Allowed range: -500 - 500
44 gimbal_tilt_trim = 0
45 Allowed range: -500 - 500
47 gimbal_roll_trim = 0
48 Allowed range: -500 - 500
49 ```
51 ## Gimbal and Headtracker on a single uart
52 As INAV does not process any inputs from the Walksnail Gimbal, it is possible to share the uart with the Walksnail Headtracking output by connect the fc TX to the gimbal and RX to receive the headtracker input.
53 ```
54 gimbal_serial_single_uart = OFF
55 Allowed values: OFF, ON
56 ```